repo parameter
run_id parameter
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get your public key endpoint.
ID of the key you used to encrypt the secret.
name parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
artifact_id parameter
owner parameter
repo parameter
name parameter
owner parameter
repo parameter
archive_format parameter
artifact_id parameter
owner parameter
repo parameter
artifact_id parameter
owner parameter
repo parameter
owner parameter
repo parameter
name parameter
owner parameter
repo parameter
owner parameter
repo parameter
runner_id parameter
owner parameter
repo parameter
workflow_id parameter
job_id parameter
owner parameter
repo parameter
owner parameter
repo parameter
run_id parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
repo parameter
Filters jobs by their completed_at timestamp. Can be one of:
* latest: Returns jobs from the most recent execution of the workflow run.
* all: Returns all jobs for a workflow run, including from old executions of the workflow run.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
run_id parameter
Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
Returns workflow runs associated with a branch. Use the name of the branch of the push.
Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
job_id parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
run_id parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
run_id parameter
Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
Returns workflow runs associated with a branch. Use the name of the branch of the push.
Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."
workflow_id parameter
owner parameter
repo parameter
run_id parameter
owner parameter
repo parameter
runner_id parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
thread_id parameter
owner parameter
repo parameter
thread_id parameter
Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
thread_id parameter
Page number of the results to fetch.
Results per page (max 100)
username parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
username parameter
Page number of the results to fetch.
Results per page (max 100)
username parameter
If true, show notifications marked as read.
Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Page number of the results to fetch.
If true, only shows notifications in which the user is directly participating or mentioned.
Results per page (max 100)
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
If true, show notifications marked as read.
Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Page number of the results to fetch.
If true, only shows notifications in which the user is directly participating or mentioned.
Results per page (max 100)
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
If true, show notifications marked as read.
Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
owner parameter
Page number of the results to fetch.
If true, only shows notifications in which the user is directly participating or mentioned.
Results per page (max 100)
repo parameter
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
org parameter
Page number of the results to fetch.
Results per page (max 100)
username parameter
Page number of the results to fetch.
Results per page (max 100)
org parameter
Page number of the results to fetch.
Results per page (max 100)
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Page number of the results to fetch.
Results per page (max 100)
username parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
username parameter
Page number of the results to fetch.
Results per page (max 100)
username parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
If true, show notifications marked as read.
Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
owner parameter
Page number of the results to fetch.
If true, only shows notifications in which the user is directly participating or mentioned.
Results per page (max 100)
repo parameter
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
One of asc (ascending) or desc (descending).
Page number of the results to fetch.
Results per page (max 100)
One of created (when the repository was starred) or updated (when it was last pushed to).
One of asc (ascending) or desc (descending).
Page number of the results to fetch.
Results per page (max 100)
One of created (when the repository was starred) or updated (when it was last pushed to).
username parameter
Page number of the results to fetch.
Results per page (max 100)
username parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Page number of the results to fetch.
Results per page (max 100)
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
owner parameter
repo parameter
Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
owner parameter
repo parameter
thread_id parameter
Determines if all notifications should be blocked from this repository.
owner parameter
repo parameter
Determines if notifications should be received from this repository.
Unsubscribes and subscribes you to a conversation. Set ignored to true to block all notifications from this thread.
thread_id parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
installation_id parameter
repository_id parameter
account_id parameter
account_id parameter
access_token parameter
client_id parameter
The OAuth access token used to authenticate to the GitHub API.
client_id parameter
The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.
content_reference_id parameter
The title of the content attachment displayed in the body or comment of an issue or pull request.
code parameter
installation_id parameter
The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "GitHub App permissions."
The ids of the repositories that the installation token can access. Providing repository ids restricts the access of an installation token to specific repositories. You can use the "List repositories" endpoint to get the id of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.
The OAuth access token used to authenticate to the GitHub API.
client_id parameter
installation_id parameter
The OAuth access token used to authenticate to the GitHub API.
client_id parameter
org parameter
owner parameter
repo parameter
username parameter
app_slug parameter
installation_id parameter
org parameter
owner parameter
repo parameter
account_id parameter
account_id parameter
username parameter
To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.
Page number of the results to fetch.
Results per page (max 100)
plan_id parameter
Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.
To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.
Page number of the results to fetch.
Results per page (max 100)
plan_id parameter
Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.
To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.
Page number of the results to fetch.
Results per page (max 100)
plan_id parameter
Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.
To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.
Page number of the results to fetch.
Results per page (max 100)
plan_id parameter
Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.
installation_id parameter
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
installation_id parameter
repository_id parameter
access_token parameter
client_id parameter
The OAuth access token used to authenticate to the GitHub API.
client_id parameter
access_token parameter
client_id parameter
access_token parameter
client_id parameter
Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see "Check runs and requested actions." To learn more about check runs and requested actions, see "Check runs and requested actions."
The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. When the conclusion is action_required, additional details should be provided on the site specified by details_url.
Note: Providing conclusion will automatically set the status parameter to completed. Only GitHub can change a check run conclusion to stale.
The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.
A reference for the run on the integrator's system.
The SHA of the commit.
The name of the check. For example, "code-coverage".
Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.
owner parameter
repo parameter
The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The current status. Can be one of queued, in_progress, or completed.
The sha of the head commit.
owner parameter
repo parameter
check_run_id parameter
owner parameter
repo parameter
check_suite_id parameter
owner parameter
repo parameter
check_run_id parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Returns check runs with the specified name.
Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
ref parameter
repo parameter
Returns check runs with the specified status. Can be one of queued, in_progress, or completed.
Returns check runs with the specified name.
check_suite_id parameter
Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Returns check runs with the specified status. Can be one of queued, in_progress, or completed.
Filters check suites by GitHub App id.
Filters checks suites by the name of the check run.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
ref parameter
repo parameter
check_suite_id parameter
owner parameter
repo parameter
Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.
owner parameter
repo parameter
Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see "Check runs and requested actions."
check_run_id parameter
The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required.
Note: Providing conclusion will automatically set the status parameter to completed. Only GitHub can change a check run conclusion to stale.
The URL of the integrator's site that has the full details of the check.
A reference for the run on the integrator's system.
The name of the check. For example, "code-coverage".
Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.
owner parameter
repo parameter
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The current status. Can be one of queued, in_progress, or completed.
key parameter
owner parameter
repo parameter
gist_id parameter
The comment text.
gist_id parameter
A descriptive name for this gist.
The filenames and content of each file in the gist. The keys in the files object represent the filename and have the type string.
When true, the gist will be public and available for anyone to see.
comment_id parameter
gist_id parameter
gist_id parameter
gist_id parameter
comment_id parameter
gist_id parameter
gist_id parameter
gist_id parameter
sha parameter
gist_id parameter
Page number of the results to fetch.
Results per page (max 100)
gist_id parameter
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
Page number of the results to fetch.
Results per page (max 100)
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
username parameter
gist_id parameter
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
Page number of the results to fetch.
Results per page (max 100)
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
username parameter
Page number of the results to fetch.
Results per page (max 100)
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
gist_id parameter
gist_id parameter
The comment text.
comment_id parameter
gist_id parameter
A descriptive name for this gist.
The filenames and content that make up this gist.
gist_id parameter
The new blob's content.
The encoding used for content. Currently, "utf-8" and "base64" are supported.
owner parameter
repo parameter
Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.
Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.
The commit message
owner parameter
The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.
repo parameter
The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.
The SHA of the tree object this commit points to
owner parameter
The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
repo parameter
The SHA1 value for this reference.
The tag message.
The SHA of the git object this is tagging.
owner parameter
repo parameter
The tag's name. This is typically a version (e.g., "v0.0.1").
An object with information about the individual creating the tag.
The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.
owner parameter
repo parameter
Objects (of path, mode, type, and sha) specifying a tree structure.
owner parameter
ref parameter
repo parameter
file_sha parameter
owner parameter
repo parameter
commit_sha parameter
owner parameter
repo parameter
owner parameter
ref parameter
repo parameter
owner parameter
repo parameter
tag_sha parameter
owner parameter
recursive parameter
repo parameter
tree_sha parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
ref parameter
repo parameter
Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.
owner parameter
ref parameter
repo parameter
The SHA1 value to set this reference to
name parameter
Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: existing_users, contributors_only, or collaborators_only.
org parameter
Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: existing_users, contributors_only, or collaborators_only.
owner parameter
repo parameter
org parameter
owner parameter
repo parameter
org parameter
owner parameter
repo parameter
Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.
issue_number parameter
owner parameter
repo parameter
issue_number parameter
The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.
owner parameter
repo parameter
assignee parameter
owner parameter
repo parameter
The contents of the comment.
issue_number parameter
owner parameter
repo parameter
Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.
Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.
The contents of the issue.
Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.
The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.
owner parameter
repo parameter
The title of the issue.
The hexadecimal color code for the label, without the leading #.
A short description of the label.
The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji
. For a full list of available emoji and codes, see emoji-cheat-sheet.com.
owner parameter
repo parameter
A description of the milestone.
The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
owner parameter
repo parameter
The state of the milestone. Either open or closed.
The title of the milestone.
comment_id parameter
owner parameter
repo parameter
name parameter
owner parameter
repo parameter
milestone_number parameter
owner parameter
repo parameter
comment_id parameter
owner parameter
repo parameter
issue_number parameter
owner parameter
repo parameter
event_id parameter
owner parameter
repo parameter
name parameter
owner parameter
repo parameter
milestone_number parameter
owner parameter
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
issue_number parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Either asc or desc. Ignored without the sort parameter.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Either created or updated.
The direction of the sort. Can be either asc or desc.
Indicates which sorts of issues to return. Can be one of:
* assigned: Issues assigned to you
* created: Issues created by you
* mentioned: Issues mentioning you
* subscribed: Issues you're subscribed to updates for
* all: All issues the authenticated user can see, regardless of participation or creation
A list of comma separated label names. Example: bug,ui,@high
Page number of the results to fetch.
Results per page (max 100)
Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
What to sort results by. Can be either created, updated, comments.
Indicates the state of the issues to return. Can be either open, closed, or all.
issue_number parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
issue_number parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
The direction of the sort. Can be either asc or desc.
Indicates which sorts of issues to return. Can be one of:
* assigned: Issues assigned to you
* created: Issues created by you
* mentioned: Issues mentioning you
* subscribed: Issues you're subscribed to updates for
* all: All issues the authenticated user can see, regardless of participation or creation
A list of comma separated label names. Example: bug,ui,@high
Page number of the results to fetch.
Results per page (max 100)
Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
What to sort results by. Can be either created, updated, comments.
Indicates the state of the issues to return. Can be either open, closed, or all.
The direction of the sort. Can be either asc or desc.
Indicates which sorts of issues to return. Can be one of:
* assigned: Issues assigned to you
* created: Issues created by you
* mentioned: Issues mentioning you
* subscribed: Issues you're subscribed to updates for
* all: All issues the authenticated user can see, regardless of participation or creation
A list of comma separated label names. Example: bug,ui,@high
org parameter
Page number of the results to fetch.
Results per page (max 100)
Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
What to sort results by. Can be either created, updated, comments.
Indicates the state of the issues to return. Can be either open, closed, or all.
Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.
The user that created the issue.
The direction of the sort. Can be either asc or desc.
A list of comma separated label names. Example: bug,ui,@high
A user that's mentioned in the issue.
If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
What to sort results by. Can be either created, updated, comments.
Indicates the state of the issues to return. Can be either open, closed, or all.
milestone_number parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
issue_number parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
The direction of the sort. Either asc or desc.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
What to sort results by. Either due_on or completeness.
The state of the milestone. Either open, closed, or all.
issue_number parameter
The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
* off-topic
* too heated
* resolved
* spam
owner parameter
repo parameter
issue_number parameter
owner parameter
repo parameter
Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.
issue_number parameter
owner parameter
repo parameter
issue_number parameter
name parameter
owner parameter
repo parameter
issue_number parameter
owner parameter
repo parameter
issue_number parameter
The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.
owner parameter
repo parameter
issue_number parameter
The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.
owner parameter
repo parameter
issue_number parameter
owner parameter
repo parameter
The contents of the comment.
comment_id parameter
owner parameter
repo parameter
Login for the user that this issue should be assigned to. This field is deprecated.
Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.
The contents of the issue.
issue_number parameter
Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.
The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.
owner parameter
repo parameter
State of the issue. Either open or closed.
The title of the issue.
The hexadecimal color code for the label, without the leading #.
A short description of the label.
name parameter
The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji
. For a full list of available emoji and codes, see emoji-cheat-sheet.com.
owner parameter
repo parameter
A description of the milestone.
The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
milestone_number parameter
owner parameter
repo parameter
The state of the milestone. Either open or closed.
The title of the milestone.
license parameter
owner parameter
repo parameter
The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.
The rendering mode. Can be either:
* markdown to render a document in plain Markdown, just like README.md files are rendered.
* gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.
The Markdown text to render in HTML. Markdown content must be 400 KB or less.
data parameter
owner parameter
repo parameter
migration_id parameter
migration_id parameter
org parameter
migration_id parameter
org parameter
migration_id parameter
migration_id parameter
org parameter
owner parameter
repo parameter
Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the raw step.
owner parameter
repo parameter
owner parameter
repo parameter
migration_id parameter
migration_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
org parameter
Page number of the results to fetch.
Results per page (max 100)
migration_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
migration_id parameter
Page number of the results to fetch.
Results per page (max 100)
author_id parameter
The new Git author email.
The new Git author name.
owner parameter
repo parameter
owner parameter
repo parameter
Can be one of opt_in (large files will be stored using Git LFS) or opt_out (large files will be removed during the import).
Does not include attachments uploaded to GitHub.com in the migration data when set to true. Excluding attachments will reduce the migration archive file size.
Locks the repositories to prevent changes during the migration when set to true.
An array of repositories to include in the migration.
Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
org parameter
A list of arrays indicating which repositories should be migrated.
owner parameter
repo parameter
For a tfvc import, the name of the project that is being imported.
The originating VCS type. Can be one of subversion, git, mercurial, or tfvc. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.
If authentication is required, the password to provide to vcs_url.
The URL of the originating repository.
If authentication is required, the username to provide to vcs_url.
migration_id parameter
repo_name parameter
migration_id parameter
org parameter
repo_name parameter
owner parameter
repo parameter
The password to provide to the originating repository.
The username to provide to the originating repository.
access_token parameter
client_id parameter
The 20 character OAuth app client key for which to create the token.
The 40 character OAuth app client secret for which to create the token.
A unique string to distinguish an authorization from others created for the same client ID and user.
A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.
A URL to remind you what app the OAuth token is for.
A list of scopes that this authorization is in.
authorization_id parameter
grant_id parameter
authorization_id parameter
grant_id parameter
client_id parameter
The 40 character OAuth app client secret associated with the client ID specified in the URL.
fingerprint parameter
A note to remind you what the OAuth token is for.
A URL to remind you what app the OAuth token is for.
A list of scopes that this authorization is in.
client_id parameter
The 40 character OAuth app client secret associated with the client ID specified in the URL.
A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to Get-or-create an authorization for a specific app and fingerprint.
A note to remind you what the OAuth token is for.
A URL to remind you what app the OAuth token is for.
A list of scopes that this authorization is in.
client_id parameter
The 40 character OAuth app client secret associated with the client ID specified in the URL.
fingerprint parameter
A note to remind you what the OAuth token is for.
A URL to remind you what app the OAuth token is for.
A list of scopes that this authorization is in.
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
access_token parameter
client_id parameter
access_token parameter
client_id parameter
access_token parameter
client_id parameter
A list of scopes to add to this authorization.
authorization_id parameter
A unique string to distinguish an authorization from others created for the same client ID and user.
A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.
A URL to remind you what app the OAuth token is for.
A list of scopes to remove from this authorization.
Replaces the authorization scopes with these.
org parameter
The role to give the user in the organization. Can be one of:
* admin - The user will become an owner of the organization.
* member - The user will become a non-owner member of the organization.
username parameter
org parameter
username parameter
org parameter
username parameter
org parameter
username parameter
org parameter
username parameter
org parameter
username parameter
org parameter
username parameter
Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Key/value pairs to provide settings for this webhook. These are defined below.
Determines what events the hook is triggered for.
Must be passed as "web".
org parameter
Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.
Required unless you provide email. GitHub user ID for the person you are inviting.
org parameter
Specify role for new member. Can be one of:
* admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
* direct_member - Non-owner organization members with ability to see other members and join teams by invitation.
* billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.
Specify IDs for the teams you want to invite new members to.
hook_id parameter
org parameter
org parameter
hook_id parameter
org parameter
org parameter
username parameter
org parameter
org parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
The integer ID of the last organization that you've seen.
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
username parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
org parameter
Page number of the results to fetch.
Results per page (max 100)
invitation_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
Filter members returned in the list. Can be one of:
* 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners.
* all - All members the authenticated user can see.
org parameter
Page number of the results to fetch.
Results per page (max 100)
Filter members returned by their role. Can be one of:
* all - All members of the organization, regardless of role.
* admin - Organization owners.
* member - Non-owner organization members.
Page number of the results to fetch.
Results per page (max 100)
Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.
Filter the list of outside collaborators. Can be one of:
* 2fa_disabled: Outside collaborators without two-factor authentication enabled.
* all: All outside collaborators.
org parameter
Page number of the results to fetch.
Results per page (max 100)
org parameter
Page number of the results to fetch.
Results per page (max 100)
org parameter
Page number of the results to fetch.
Results per page (max 100)
hook_id parameter
org parameter
org parameter
username parameter
credential_id parameter
org parameter
org parameter
username parameter
org parameter
username parameter
org parameter
username parameter
org parameter
username parameter
Billing email address. This address is not publicized.
The company name.
Default permission level members have for organization repositories:
* read - can pull, but not push to or administer this repository.
* write - can pull and push, but not administer this repository.
* admin - can pull, push, and administer this repository.
* none - no permissions granted by default.
The description of the company.
The publicly visible email address.
Toggles whether an organization can use organization projects.
Toggles whether repositories that belong to the organization can use repository projects.
The location.
Specifies which types of repositories non-admin organization members can create. Can be one of:
* all - all organization members can create public and private repositories.
* private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud.
* none - only admin members can create repositories.
Note: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See this note for details.
Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of:
* true - all organization members can create internal repositories.
* false - only organization owners can create internal repositories.
Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of:
* true - all organization members can create private repositories.
* false - only organization owners can create private repositories.
Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of:
* true - all organization members can create public repositories.
* false - only organization owners can create public repositories.
Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
Toggles the ability of non-admin organization members to create repositories. Can be one of:
* true - all organization members can create repositories.
* false - only organization owners can create repositories.
Default: true
Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.
The shorthand name of the company.
org parameter
Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Key/value pairs to provide settings for this webhook. These are defined below.
Determines what events the hook is triggered for.
hook_id parameter
org parameter
org parameter
The state that the membership should be in. Only "active" will be accepted.
The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs." Can be one of:
* read - can read, but not write to or administer this project.
* write - can read and write, but not administer this project.
* admin - can read, write and administer this project.
project_id parameter
username parameter
column_id parameter
The issue or pull request id you want to associate with this card. You can use the List repository issues and List pull requests endpoints to find this id.
Note: Depending on whether you use the issue id or pull request id, you will need to specify Issue or PullRequest as the content_type.
Required if you provide content_id. The type of content you want to associate with this card. Use Issue when content_id is an issue id and use PullRequest when content_id is a pull request id.
The card's note content. Only valid for cards without another type of content, so you must omit when specifying content_id and content_type.
The name of the column.
project_id parameter
The description of the project.
The name of the project.
The description of the project.
The name of the project.
org parameter
The description of the project.
The name of the project.
owner parameter
repo parameter
card_id parameter
column_id parameter
project_id parameter
card_id parameter
column_id parameter
project_id parameter
Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.
column_id parameter
Page number of the results to fetch.
Results per page (max 100)
Filters the collaborators by their affiliation. Can be one of:
* outside: Outside collaborators of a project that are not a member of the project's organization.
* direct: Collaborators with permissions to a project, regardless of organization membership status.
* all: All collaborators the authenticated user can see.
Page number of the results to fetch.
Results per page (max 100)
project_id parameter
Page number of the results to fetch.
Results per page (max 100)
project_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
Indicates the state of the projects to return. Can be either open, closed, or all.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Indicates the state of the projects to return. Can be either open, closed, or all.
Page number of the results to fetch.
Results per page (max 100)
Indicates the state of the projects to return. Can be either open, closed, or all.
username parameter
card_id parameter
The id value of a column in the same project.
Can be one of top, bottom, or after:<card_id>, where <card_id> is the id value of a card in the same column, or in the new column specified by column_id.
column_id parameter
Can be one of first, last, or after:<column_id>, where <column_id> is the id value of a column in the same project.
project_id parameter
username parameter
project_id parameter
username parameter
Use true to archive a project card. Specify false if you need to restore a previously archived project card.
card_id parameter
The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a content_id and content_type.
column_id parameter
The new name of the column.
The description of the project.
The name of the project.
The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting organization_permission is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by organization_permission. For information on changing access for a team or collaborator, see Add or update team project or Add user as a collaborator.
Note: Updating a project's organization_permission requires admin access to the project.
Can be one of:
* read - Organization members can read, but not write to or administer this project.
* write - Organization members can read and write, but not administer this project.
* admin - Organization members can read, write and administer this project.
* none - Organization members can only see this project if it is public.
Sets the visibility of a project board. Setting private is only available for organization and user projects. Note: Updating a project's visibility requires admin access to the project.
Can be one of:
* false - Anyone can see the project.
* true - Only the user can view a project board created on a user account. Organization members with the appropriate organization_permission can see project boards in an organization account.
project_id parameter
State of the project. Either open or closed.
owner parameter
pull_number parameter
repo parameter
The text of the review comment.
The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.
Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.
owner parameter
The relative path to the file that necessitates a comment.
Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
pull_number parameter
repo parameter
Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.
Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.
Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.
The text of the review comment.
The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.
Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.
owner parameter
The relative path to the file that necessitates a comment.
Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
pull_number parameter
repo parameter
Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.
Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.
Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.
The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.
The contents of the pull request.
Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.
The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.
Indicates whether maintainers can modify the pull request.
owner parameter
repo parameter
The title of the new pull request.
The text of the review comment.
comment_id parameter
owner parameter
pull_number parameter
repo parameter
Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.
Use the following table to specify the location, destination, and contents of the draft review comment.
The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
owner parameter
pull_number parameter
repo parameter
owner parameter
pull_number parameter
repo parameter
An array of user logins that will be requested.
An array of team slugs that will be requested.
comment_id parameter
owner parameter
repo parameter
owner parameter
pull_number parameter
repo parameter
review_id parameter
owner parameter
pull_number parameter
repo parameter
An array of user logins that will be removed.
An array of team slugs that will be removed.
The message for the pull request review dismissal
owner parameter
pull_number parameter
repo parameter
review_id parameter
comment_id parameter
owner parameter
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
pull_number parameter
repo parameter
review_id parameter
owner parameter
pull_number parameter
repo parameter
owner parameter
pull_number parameter
repo parameter
review_id parameter
Can be either asc or desc. Ignored without sort parameter.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
pull_number parameter
repo parameter
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.
Can be either created or updated comments.
Can be either asc or desc. Ignored without sort parameter.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.
Can be either created or updated comments.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
pull_number parameter
repo parameter
Filter pulls by base branch name. Example: gh-pages.
The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.
Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).
Either open, closed, or all to filter by state.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
pull_number parameter
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
pull_number parameter
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
pull_number parameter
repo parameter
Extra detail to append to automatic commit message.
Title for the automatic commit message.
Merge method to use. Possible values are merge, squash or rebase. Default is merge.
owner parameter
pull_number parameter
repo parameter
SHA that pull request head must match to allow merge.
The body text of the pull request review
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.
owner parameter
pull_number parameter
repo parameter
review_id parameter
The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the "List commits on a repository" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
owner parameter
pull_number parameter
repo parameter
The text of the reply to the review comment.
comment_id parameter
owner parameter
repo parameter
The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.
The contents of the pull request.
Indicates whether maintainers can modify the pull request.
owner parameter
pull_number parameter
repo parameter
State of this Pull Request. Either open or closed.
The title of the pull request.
The body text of the pull request review.
owner parameter
pull_number parameter
repo parameter
review_id parameter
comment_id parameter
The reaction type to add to the commit comment.
owner parameter
repo parameter
comment_id parameter
The reaction type to add to the issue comment.
owner parameter
repo parameter
The reaction type to add to the issue.
issue_number parameter
owner parameter
repo parameter
comment_id parameter
The reaction type to add to the pull request review comment.
owner parameter
repo parameter
comment_number parameter
The reaction type to add to the team discussion comment.
discussion_number parameter
team_id parameter
comment_number parameter
The reaction type to add to the team discussion comment.
discussion_number parameter
org parameter
team_slug parameter
comment_number parameter
The reaction type to add to the team discussion comment.
discussion_number parameter
team_id parameter
The reaction type to add to the team discussion.
discussion_number parameter
team_id parameter
The reaction type to add to the team discussion.
discussion_number parameter
org parameter
team_slug parameter
The reaction type to add to the team discussion.
discussion_number parameter
team_id parameter
reaction_id parameter
comment_id parameter
owner parameter
reaction_id parameter
repo parameter
comment_id parameter
owner parameter
reaction_id parameter
repo parameter
issue_number parameter
owner parameter
reaction_id parameter
repo parameter
comment_id parameter
owner parameter
reaction_id parameter
repo parameter
comment_number parameter
discussion_number parameter
org parameter
reaction_id parameter
team_slug parameter
discussion_number parameter
org parameter
reaction_id parameter
team_slug parameter
reaction_id parameter
comment_id parameter
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
comment_id parameter
Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Returns a single reaction type. Omit this parameter to list all reactions to an issue.
issue_number parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
comment_id parameter
Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
comment_number parameter
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
discussion_number parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
comment_number parameter
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
discussion_number parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
team_slug parameter
comment_number parameter
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
discussion_number parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
discussion_number parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
discussion_number parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
team_slug parameter
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
discussion_number parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
invitation_id parameter
owner parameter
The permission to grant the collaborator. Only valid on organization-owned repositories. Can be one of:
* pull - can pull, but not push to or administer this repository.
* push - can pull and push, but not administer this repository.
* admin - can pull, push and administer this repository.
* maintain - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.
* triage - Recommended for contributors who need to proactively manage issues and pull requests without write access.
repo parameter
username parameter
The contents of the key.
owner parameter
If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."
repo parameter
A name for the key.
branch parameter
owner parameter
repo parameter
apps parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
contexts parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
teams parameter
branch parameter
owner parameter
repo parameter
users parameter
owner parameter
repo parameter
username parameter
owner parameter
repo parameter
base parameter
head parameter
owner parameter
repo parameter
The contents of the comment.
commit_sha parameter
Deprecated. Use position parameter instead. Line number in the file to comment on.
owner parameter
Relative path of the file to comment on.
Line index in the diff to comment on.
repo parameter
Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
Short description of the deployment.
Name for the target deployment environment (e.g., production, staging, qa).
owner parameter
JSON payload with extra information about the deployment.
Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.
Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
The ref to deploy. This can be a branch, tag, or SHA.
repo parameter
The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.
Specifies a task to execute (e.g., deploy or deploy:migrations).
Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false
Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true
Note: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type.
Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
deployment_id parameter
A short description of the status. The maximum description length is 140 characters.
Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. Note: This parameter requires you to use the application/vnd.github.flash-preview+json custom media type.
Sets the URL for accessing your environment. Default: ""
Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: ""
Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
owner parameter
repo parameter
The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.
JSON payload with extra information about the webhook event that your action or worklow may use.
Required: A custom webhook event name.
owner parameter
repo parameter
The author of the file. Default: The committer or the authenticated user if you omit committer.
The branch name. Default: the repository’s default branch (usually master)
The person that committed the file. Default: the authenticated user.
The new file content, using Base64 encoding.
The commit message.
owner parameter
path parameter
repo parameter
Required if you are updating a file. The blob SHA of the file being replaced.
Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.
Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Pass true to create an initial commit with empty README.
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
A short description of the repository.
Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".
Either true to enable issues for this repository or false to disable them.
Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.
Either true to enable the wiki for this repository or false to disable it.
A URL with more information about the repository.
Either true to make this repo available as a template repository or false to prevent it.
Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".
The name of the repository.
Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.
The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation.
The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.
Optional parameter to specify the organization name if forking into an organization.
owner parameter
repo parameter
Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Key/value pairs to provide settings for this webhook. These are defined below.
Determines what events the hook is triggered for.
Use web to create a webhook. Default: web. This parameter only accepts the value web.
owner parameter
repo parameter
Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.
Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Pass true to create an initial commit with empty README.
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
A short description of the repository.
Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".
Either true to enable issues for this repository or false to disable them.
Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.
Either true to enable the wiki for this repository or false to disable it.
A URL with more information about the repository.
Either true to make this repo available as a template repository or false to prevent it.
Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".
The name of the repository.
org parameter
Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.
The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation.
The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.
The author of the file. Default: The committer or the authenticated user if you omit committer.
The branch name. Default: the repository’s default branch (usually master)
The person that committed the file. Default: the authenticated user.
The new file content, using Base64 encoding.
The commit message.
owner parameter
path parameter
repo parameter
Required if you are updating a file. The blob SHA of the file being replaced.
Text describing the contents of the tag.
true to create a draft (unpublished) release, false to create a published one.
The name of the release.
owner parameter
true to identify the release as a prerelease. false to identify the release as a full release.
repo parameter
The name of the tag.
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
A string label to differentiate this status from the status of other systems.
A short description of the status.
owner parameter
repo parameter
sha parameter
The state of the status. Can be one of error, failure, pending, or success.
The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
http://ci.example.com/user/repo/build/sha
A short description of the new repository.
The name of the new repository.
The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.
Either true to create a new private repository or false to create a new public one.
template_owner parameter
template_repo parameter
invitation_id parameter
comment_id parameter
owner parameter
repo parameter
deployment_id parameter
owner parameter
repo parameter
download_id parameter
owner parameter
repo parameter
owner parameter
repo parameter
object containing information about the author.
The branch name. Default: the repository’s default branch (usually master)
object containing information about the committer.
The commit message.
owner parameter
path parameter
repo parameter
The blob SHA of the file being replaced.
hook_id parameter
owner parameter
repo parameter
invitation_id parameter
owner parameter
repo parameter
asset_id parameter
owner parameter
repo parameter
owner parameter
release_id parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
source parameter
owner parameter
repo parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
archive_format parameter
owner parameter
ref parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
owner parameter
Must be one of: day, week.
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
username parameter
owner parameter
ref parameter
repo parameter
owner parameter
repo parameter
comment_id parameter
owner parameter
repo parameter
owner parameter
ref parameter
repo parameter
owner parameter
path parameter
The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
repo parameter
owner parameter
repo parameter
key_id parameter
owner parameter
repo parameter
deployment_id parameter
owner parameter
repo parameter
deployment_id parameter
owner parameter
repo parameter
status_id parameter
download_id parameter
owner parameter
repo parameter
owner parameter
repo parameter
hook_id parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
build_id parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
repo parameter
asset_id parameter
owner parameter
repo parameter
owner parameter
repo parameter
tag parameter
owner parameter
release_id parameter
repo parameter
branch parameter
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
owner parameter
Must be one of: day, week.
repo parameter
branch parameter
owner parameter
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
release_id parameter
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.
repo parameter
commit_sha parameter
owner parameter
repo parameter
Filter collaborators returned by their affiliation. Can be one of:
* outside: All outside collaborators of an organization-owned repository.
* direct: All collaborators with permissions to an organization-owned repository, regardless of organization membership status.
* all: All collaborators the authenticated user can see.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
commit_sha parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
GitHub login or email address by which to filter by commit author.
owner parameter
Page number of the results to fetch.
Only commits containing this file path will be returned.
Results per page (max 100)
repo parameter
SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Set to 1 or true to include anonymous contributors in results.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
deployment_id parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
The name of the environment that was deployed to (e.g., staging or production).
owner parameter
Page number of the results to fetch.
Results per page (max 100)
The name of the ref. This can be a branch, tag, or SHA.
repo parameter
The SHA recorded at creation time.
The name of the task for the deployment (e.g., deploy or deploy:migrations).
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Comma-separated list of values. Can include:
* owner: Repositories that are owned by the authenticated user.
* collaborator: Repositories that the user has been added to as a collaborator.
* organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
Can be one of asc or desc. Default: asc when using full_name, otherwise desc
Page number of the results to fetch.
Results per page (max 100)
Can be one of created, updated, pushed, full_name.
Can be one of all, owner, public, private, member. Default: all
Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.
Can be one of all, public, or private.
Comma-separated list of values. Can include:
* owner: Repositories that are owned by the authenticated user.
* collaborator: Repositories that the user has been added to as a collaborator.
* organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
Can be one of asc or desc. Default: asc when using full_name, otherwise desc
Page number of the results to fetch.
Results per page (max 100)
Can be one of created, updated, pushed, full_name.
Can be one of all, owner, public, private, member. Default: all
Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.
Can be one of all, public, or private.
Can be one of asc or desc. Default: when using full_name: asc, otherwise desc
org parameter
Page number of the results to fetch.
Results per page (max 100)
Can be one of created, updated, pushed, full_name.
Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.
Can be one of asc or desc. Default: asc when using full_name, otherwise desc
Page number of the results to fetch.
Results per page (max 100)
Can be one of created, updated, pushed, full_name.
Can be one of all, owner, member.
username parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
The sort order. Can be either newest, oldest, or stargazers.
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
Page number of the results to fetch.
Results per page (max 100)
owner parameter
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
Page number of the results to fetch.
Results per page (max 100)
The integer ID of the last repository that you've seen.
commit_sha parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
ref parameter
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
owner parameter
Page number of the results to fetch.
Results per page (max 100)
repo parameter
branch parameter
owner parameter
repo parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
The name of the base branch that the head will be merged into.
Commit message to use for the merge commit. If omitted, a default message will be used.
The head to merge. This can be a branch name or a commit SHA1.
owner parameter
repo parameter
hook_id parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
owner parameter
repo parameter
username parameter
key_id parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
apps parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
contexts parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
teams parameter
branch parameter
owner parameter
repo parameter
users parameter
An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.
owner parameter
repo parameter
apps parameter
branch parameter
owner parameter
repo parameter
branch parameter
contexts parameter
owner parameter
repo parameter
branch parameter
owner parameter
repo parameter
teams parameter
branch parameter
owner parameter
repo parameter
users parameter
An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.
owner parameter
repo parameter
owner parameter
repo parameter
owner parameter
repo parameter
hook_id parameter
owner parameter
repo parameter
Required: The username or organization name the repository will be transferred to.
owner parameter
repo parameter
ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation.
Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation."
branch parameter
Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
owner parameter
repo parameter
Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see "Requiring a linear commit history" in the GitHub Help documentation.
Require at least one approving review on a pull request, before merging. Set to null to disable.
Require status checks to pass before merging. Set to null to disable.
Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.
The contents of the comment
comment_id parameter
owner parameter
repo parameter
Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.
Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Either true to allow squash-merging pull requests, or false to prevent squash-merging.
true to archive this repository. Note: You cannot unarchive repositories through the API.
Updates the default branch for this repository.
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
A short description of the repository.
Either true to enable issues for this repository or false to disable them.
Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.
Either true to enable the wiki for this repository or false to disable it.
A URL with more information about the repository.
Either true to make this repo available as a template repository or false to prevent it.
The name of the repository.
owner parameter
Either true to make the repository private or false to make it public. Creating private repositories requires a paid GitHub account. Default: false.
Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.
repo parameter
Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.
The author of the file. Default: The committer or the authenticated user if you omit committer.
The branch name. Default: the repository’s default branch (usually master)
The person that committed the file. Default: the authenticated user.
The new file content, using Base64 encoding.
The commit message.
owner parameter
path parameter
repo parameter
Required if you are updating a file. The blob SHA of the file being replaced.
Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Determines a list of events to be added to the list of events that the Hook triggers for.
Key/value pairs to provide settings for this webhook. These are defined below.
Determines what events the hook is triggered for. This replaces the entire array of events.
hook_id parameter
owner parameter
Determines a list of events to be removed from the list of events that the Hook triggers for.
repo parameter
Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see "Using a custom domain with GitHub Pages."
owner parameter
repo parameter
Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory /docs. Possible values are "gh-pages", "master", and "master /docs".
invitation_id parameter
owner parameter
The permissions that the associated user will have on the repository. Valid values are read, write, and admin.
repo parameter
branch parameter
Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
owner parameter
repo parameter
Blocks merging pull requests until code owners have reviewed.
Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.
branch parameter
The list of status checks to require in order to merge into this branch
owner parameter
repo parameter
Require branches to be up to date before merging.
asset_id parameter
An alternate short description of the asset. Used in place of the filename.
The file name of the asset.
owner parameter
repo parameter
Text describing the contents of the tag.
true makes the release a draft, and false publishes the release.
The name of the release.
owner parameter
true to identify the release as a prerelease, false to identify the release as a full release.
release_id parameter
repo parameter
The name of the tag.
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
The raw file data
label parameter
name parameter
The URL origin (protocol + host name + port) is included in upload_url returned in the response of the "Create a release" endpoint
owner parameter
release_id parameter
repo parameter
org parameter
scim_user_id parameter
Used for pagination: the number of results to return.
Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query: ?filter=userName%20eq%20\"Octocat\".
org parameter
Used for pagination: the index of the first result to return.
org parameter
org parameter
org parameter
scim_user_id parameter
org parameter
scim_user_id parameter
org parameter
scim_user_id parameter
org parameter
scim_user_id parameter
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Page number of the results to fetch.
Results per page (max 100)
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.
Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Page number of the results to fetch.
Results per page (max 100)
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.
Sorts the results of your query by author-date or committer-date. Default: best match
The email address.
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Page number of the results to fetch.
Results per page (max 100)
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.
Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Page number of the results to fetch.
Results per page (max 100)
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.
Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match
The search term.
owner parameter
repository parameter
Indicates the state of the issues to return. Can be either open or closed.
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.
The id of the repository.
Sorts the results of your query by when the label was created or updated. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Page number of the results to fetch.
Results per page (max 100)
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.
Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match
The search term.
Filter results by language.
The sort field. if sort param is provided. Can be either asc or desc.
The sort field. One of stars, forks, or updated. Default: results are sorted by best match.
The page number to fetch.
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query.
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Page number of the results to fetch.
Results per page (max 100)
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.
Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match
The search term.
The sort field. if sort param is provided. Can be either asc or desc.
The sort field. One of stars, forks, or updated. Default: results are sorted by best match.
The page number to fetch.
team_id parameter
username parameter
team_id parameter
username parameter
The role that this user should have in the team. Can be one of:
* member - a normal member of the team.
* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.
team_id parameter
username parameter
org parameter
The role that this user should have in the team. Can be one of:
* member - a normal member of the team.
* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.
team_slug parameter
username parameter
The role that this user should have in the team. Can be one of:
* member - a normal member of the team.
* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.
team_id parameter
username parameter
The permission to grant to the team for this project. Can be one of:
* read - team members can read, but not write to or administer this project.
* write - team members can read and write, but not administer this project.
* admin - team members can read, write and administer this project.
Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
project_id parameter
team_id parameter
org parameter
The permission to grant to the team for this project. Can be one of:
* read - team members can read, but not write to or administer this project.
* write - team members can read and write, but not administer this project.
* admin - team members can read, write and administer this project.
Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
project_id parameter
team_slug parameter
The permission to grant to the team for this project. Can be one of:
* read - team members can read, but not write to or administer this project.
* write - team members can read and write, but not administer this project.
* admin - team members can read, write and administer this project.
Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
project_id parameter
team_id parameter
owner parameter
The permission to grant the team on this repository. Can be one of:
* pull - team members can pull, but not push to or administer this repository.
* push - team members can pull and push, but not administer this repository.
* admin - team members can pull, push and administer this repository.
If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
repo parameter
team_id parameter
org parameter
owner parameter
The permission to grant the team on this repository. Can be one of:
* pull - team members can pull, but not push to or administer this repository.
* push - team members can pull and push, but not administer this repository.
* admin - team members can pull, push and administer this repository.
If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
repo parameter
team_slug parameter
owner parameter
The permission to grant the team on this repository. Can be one of:
* pull - team members can pull, but not push to or administer this repository.
* push - team members can pull and push, but not administer this repository.
* admin - team members can pull, push and administer this repository.
If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
repo parameter
team_id parameter
owner parameter
repo parameter
team_id parameter
org parameter
owner parameter
repo parameter
team_slug parameter
owner parameter
repo parameter
team_id parameter
The discussion comment's body text.
discussion_number parameter
team_id parameter
The discussion comment's body text.
discussion_number parameter
org parameter
team_slug parameter
The discussion comment's body text.
discussion_number parameter
team_id parameter
The discussion post's body text.
Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.
team_id parameter
The discussion post's title.
The discussion post's body text.
org parameter
Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.
team_slug parameter
The discussion post's title.
The discussion post's body text.
Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.
team_id parameter
The discussion post's title.
The description of the team.
List GitHub IDs for organization members who will become team maintainers.
The name of the team.
org parameter
The ID of a team to set as the parent team.
Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
* pull - team members can pull, but not push to or administer newly-added repositories.
* push - team members can pull and push, but not administer newly-added repositories.
* admin - team members can pull, push and administer newly-added repositories.
The level of privacy this team should have. The options are:
For a non-nested team:
* secret - only visible to organization owners and members of this team.
* closed - visible to all members of this organization.
Default: secret
For a parent or child team:
* closed - visible to all members of this organization.
Default for child team: closed
The full name (e.g., "organization-name/repository-name") of repositories to add the team to.
The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
team_id parameter
The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
org parameter
team_slug parameter
The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
team_id parameter
comment_number parameter
discussion_number parameter
team_id parameter
comment_number parameter
discussion_number parameter
org parameter
team_slug parameter
comment_number parameter
discussion_number parameter
team_id parameter
discussion_number parameter
team_id parameter
discussion_number parameter
org parameter
team_slug parameter
discussion_number parameter
team_id parameter
team_id parameter
org parameter
team_slug parameter
team_id parameter
org parameter
team_slug parameter
comment_number parameter
discussion_number parameter
team_id parameter
comment_number parameter
discussion_number parameter
org parameter
team_slug parameter
comment_number parameter
discussion_number parameter
team_id parameter
discussion_number parameter
team_id parameter
discussion_number parameter
org parameter
team_slug parameter
discussion_number parameter
team_id parameter
team_id parameter
team_id parameter
team_id parameter
username parameter
team_id parameter
username parameter
team_id parameter
username parameter
org parameter
team_slug parameter
username parameter
team_id parameter
username parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
team_slug parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.
discussion_number parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.
discussion_number parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
team_slug parameter
Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.
discussion_number parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.
org parameter
Page number of the results to fetch.
Results per page (max 100)
team_slug parameter
Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
team_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
org parameter
team_slug parameter
Page number of the results to fetch.
Results per page (max 100)
Filters members returned by their role in the team. Can be one of:
* member - normal members of the team.
* maintainer - team maintainers.
* all - all members of the team.
team_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
Filters members returned by their role in the team. Can be one of:
* member - normal members of the team.
* maintainer - team maintainers.
* all - all members of the team.
team_slug parameter
Page number of the results to fetch.
Results per page (max 100)
Filters members returned by their role in the team. Can be one of:
* member - normal members of the team.
* maintainer - team maintainers.
* all - all members of the team.
team_id parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
team_slug parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
team_slug parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
org parameter
Page number of the results to fetch.
Results per page (max 100)
team_slug parameter
Page number of the results to fetch.
Results per page (max 100)
team_id parameter
team_id parameter
username parameter
team_id parameter
username parameter
team_id parameter
username parameter
org parameter
team_slug parameter
username parameter
team_id parameter
username parameter
project_id parameter
team_id parameter
org parameter
project_id parameter
team_slug parameter
project_id parameter
team_id parameter
owner parameter
repo parameter
team_id parameter
org parameter
owner parameter
repo parameter
team_slug parameter
owner parameter
repo parameter
team_id parameter
project_id parameter
team_id parameter
org parameter
project_id parameter
team_slug parameter
project_id parameter
team_id parameter
The discussion comment's body text.
comment_number parameter
discussion_number parameter
team_id parameter
The discussion comment's body text.
comment_number parameter
discussion_number parameter
org parameter
team_slug parameter
The discussion comment's body text.
comment_number parameter
discussion_number parameter
team_id parameter
The discussion post's body text.
discussion_number parameter
team_id parameter
The discussion post's title.
The discussion post's body text.
discussion_number parameter
org parameter
team_slug parameter
The discussion post's title.
The discussion post's body text.
discussion_number parameter
team_id parameter
The discussion post's title.
The description of the team.
The name of the team.
The ID of a team to set as the parent team.
Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
* pull - team members can pull, but not push to or administer newly-added repositories.
* push - team members can pull and push, but not administer newly-added repositories.
* admin - team members can pull, push and administer newly-added repositories.
The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
For a non-nested team:
* secret - only visible to organization owners and members of this team.
* closed - visible to all members of this organization.
For a parent or child team:
* closed - visible to all members of this organization.
team_id parameter
The description of the team.
The name of the team.
org parameter
The ID of a team to set as the parent team.
Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
* pull - team members can pull, but not push to or administer newly-added repositories.
* push - team members can pull and push, but not administer newly-added repositories.
* admin - team members can pull, push and administer newly-added repositories.
The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
For a non-nested team:
* secret - only visible to organization owners and members of this team.
* closed - visible to all members of this organization.
For a parent or child team:
* closed - visible to all members of this organization.
team_slug parameter
The description of the team.
The name of the team.
The ID of a team to set as the parent team.
Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
* pull - team members can pull, but not push to or administer newly-added repositories.
* push - team members can pull and push, but not administer newly-added repositories.
* admin - team members can pull, push and administer newly-added repositories.
The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
For a non-nested team:
* secret - only visible to organization owners and members of this team.
* closed - visible to all members of this organization.
For a parent or child team:
* closed - visible to all members of this organization.
team_id parameter
Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.
username parameter
username parameter
username parameter
target_user parameter
username parameter
Your GPG key, generated in ASCII-armored format. See "Generating a new GPG key" for help creating a GPG key.
The public SSH key to add to your GitHub account. See "Generating a new SSH key" for guidance on how to create a public SSH key.
A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".
Deletes one or more email addresses from your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.
gpg_key_id parameter
key_id parameter
username parameter
username parameter
Uses the ID for the subject_type you specified. Required when using subject_type.
Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.
username parameter
gpg_key_id parameter
key_id parameter
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
The integer ID of the last User that you've seen.
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
username parameter
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
username parameter
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
username parameter
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
Page number of the results to fetch.
Results per page (max 100)
username parameter
Specify the primary email address that needs a visibility change.
Use public to enable an authenticated user to view the specified email address, or use private so this primary email address cannot be seen publicly.
username parameter
username parameter
The new short biography of the user.
The new blog URL of the user.
The new company of the user.
The publicly visible email address of the user.
The new hiring availability of the user.
The new location of the user.
The new name of the user.
Generated using TypeDoc
owner parameter